

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>Index &#8212; Pyment 0.3.2 documentation</title>
    <link rel="stylesheet" href="_static/classic.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    './',
        VERSION:     '0.3.2',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true,
        SOURCELINK_SUFFIX: '.txt'
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="index" title="Index" href="#" />
    <link rel="search" title="Search" href="search.html" /> 
  </head>
  <body>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="#" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">Pyment 0.3.2 documentation</a> &#187;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            

<h1 id="index">Index</h1>

<div class="genindex-jumpbox">
 <a href="#_"><strong>_</strong></a>
 | <a href="#A"><strong>A</strong></a>
 | <a href="#C"><strong>C</strong></a>
 | <a href="#D"><strong>D</strong></a>
 | <a href="#G"><strong>G</strong></a>
 | <a href="#N"><strong>N</strong></a>
 | <a href="#P"><strong>P</strong></a>
 | <a href="#S"><strong>S</strong></a>
 | <a href="#W"><strong>W</strong></a>
 
</div>
<h2 id="_">_</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="pyment_doc.html#docstring.DocsTools.__init__">__init__() (docstring.DocsTools method)</a>

      <ul>
        <li><a href="pyment_doc.html#docstring.DocString.__init__">(docstring.DocString method)</a>
</li>
        <li><a href="pyment_doc.html#docstring.GoogledocTools.__init__">(docstring.GoogledocTools method)</a>
</li>
        <li><a href="pyment_doc.html#docstring.NumpydocTools.__init__">(docstring.NumpydocTools method)</a>
</li>
        <li><a href="pyment_doc.html#pyment.PyComment.__init__">(pyment.PyComment method)</a>
</li>
      </ul></li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="pyment_doc.html#docstring.DocsTools.__weakref__">__weakref__ (docstring.DocsTools attribute)</a>

      <ul>
        <li><a href="pyment_doc.html#docstring.DocString.__weakref__">(docstring.DocString attribute)</a>
</li>
        <li><a href="pyment_doc.html#docstring.GoogledocTools.__weakref__">(docstring.GoogledocTools attribute)</a>
</li>
        <li><a href="pyment_doc.html#docstring.NumpydocTools.__weakref__">(docstring.NumpydocTools attribute)</a>
</li>
        <li><a href="pyment_doc.html#pyment.PyComment.__weakref__">(pyment.PyComment attribute)</a>
</li>
      </ul></li>
  </ul></td>
</tr></table>

<h2 id="A">A</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="pyment_doc.html#docstring.DocsTools.autodetect_style">autodetect_style() (docstring.DocsTools method)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="C">C</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="pyment_doc.html#pyment.PyComment.compute_before_after">compute_before_after() (pyment.PyComment method)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="D">D</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="pyment_doc.html#pyment.PyComment.diff">diff() (pyment.PyComment method)</a>
</li>
      <li><a href="pyment_doc.html#pyment.PyComment.diff_to_file">diff_to_file() (pyment.PyComment method)</a>
</li>
      <li><a href="pyment_doc.html#pyment.PyComment.docs_init_to_class">docs_init_to_class() (pyment.PyComment method)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="pyment_doc.html#docstring.DocsTools">DocsTools (class in docstring)</a>
</li>
      <li><a href="pyment_doc.html#docstring.DocString">DocString (class in docstring)</a>
</li>
      <li><a href="pyment_doc.html#module-docstring">docstring (module)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="G">G</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="pyment_doc.html#docstring.DocString.generate_docs">generate_docs() (docstring.DocString method)</a>
</li>
      <li><a href="pyment_doc.html#docstring.NumpydocTools.get_attr_list">get_attr_list() (docstring.NumpydocTools method)</a>
</li>
      <li><a href="pyment_doc.html#docstring.DocsTools.get_doctests_indexes">get_doctests_indexes() (docstring.DocsTools method)</a>
</li>
      <li><a href="pyment_doc.html#docstring.DocsTools.get_elem_desc">get_elem_desc() (docstring.DocsTools method)</a>
</li>
      <li><a href="pyment_doc.html#docstring.DocsTools.get_elem_index">get_elem_index() (docstring.DocsTools method)</a>
</li>
      <li><a href="pyment_doc.html#docstring.DocsTools.get_elem_param">get_elem_param() (docstring.DocsTools method)</a>
</li>
      <li><a href="pyment_doc.html#docstring.GoogledocTools.get_excluded_sections">get_excluded_sections() (docstring.GoogledocTools method)</a>
</li>
      <li><a href="pyment_doc.html#docstring.DocsTools.get_group_index">get_group_index() (docstring.DocsTools method)</a>
</li>
      <li><a href="pyment_doc.html#docstring.DocsTools.get_group_key_index">get_group_key_index() (docstring.DocsTools method)</a>
</li>
      <li><a href="pyment_doc.html#docstring.DocsTools.get_group_key_line">get_group_key_line() (docstring.DocsTools method)</a>
</li>
      <li><a href="pyment_doc.html#docstring.DocsTools.get_group_line">get_group_line() (docstring.DocsTools method)</a>
</li>
      <li><a href="pyment_doc.html#docstring.DocString.get_input_docstring">get_input_docstring() (docstring.DocString method)</a>
</li>
      <li><a href="pyment_doc.html#docstring.DocString.get_input_style">get_input_style() (docstring.DocString method)</a>
</li>
      <li><a href="pyment_doc.html#docstring.DocsTools.get_key">get_key() (docstring.DocsTools method)</a>
</li>
      <li><a href="pyment_doc.html#docstring.DocsTools.get_key_index">get_key_index() (docstring.DocsTools method)</a>
</li>
      <li><a href="pyment_doc.html#docstring.GoogledocTools.get_key_section_header">get_key_section_header() (docstring.GoogledocTools method)</a>

      <ul>
        <li><a href="pyment_doc.html#docstring.NumpydocTools.get_key_section_header">(docstring.NumpydocTools method)</a>
</li>
      </ul></li>
      <li><a href="pyment_doc.html#docstring.GoogledocTools.get_list_key">get_list_key() (docstring.GoogledocTools method)</a>

      <ul>
        <li><a href="pyment_doc.html#docstring.NumpydocTools.get_list_key">(docstring.NumpydocTools method)</a>
</li>
      </ul></li>
      <li><a href="pyment_doc.html#docstring.GoogledocTools.get_mandatory_sections">get_mandatory_sections() (docstring.GoogledocTools method)</a>
</li>
      <li><a href="pyment_doc.html#docstring.GoogledocTools.get_next_section_lines">get_next_section_lines() (docstring.GoogledocTools method)</a>

      <ul>
        <li><a href="pyment_doc.html#docstring.NumpydocTools.get_next_section_lines">(docstring.NumpydocTools method)</a>
</li>
      </ul></li>
      <li><a href="pyment_doc.html#docstring.GoogledocTools.get_next_section_start_line">get_next_section_start_line() (docstring.GoogledocTools method)</a>

      <ul>
        <li><a href="pyment_doc.html#docstring.NumpydocTools.get_next_section_start_line">(docstring.NumpydocTools method)</a>
</li>
      </ul></li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="pyment_doc.html#docstring.GoogledocTools.get_optional_sections">get_optional_sections() (docstring.GoogledocTools method)</a>
</li>
      <li><a href="pyment_doc.html#pyment.PyComment.get_output_docs">get_output_docs() (pyment.PyComment method)</a>
</li>
      <li><a href="pyment_doc.html#docstring.DocString.get_output_style">get_output_style() (docstring.DocString method)</a>
</li>
      <li><a href="pyment_doc.html#docstring.DocsTools.get_param_description_indexes">get_param_description_indexes() (docstring.DocsTools method)</a>
</li>
      <li><a href="pyment_doc.html#docstring.DocsTools.get_param_indexes">get_param_indexes() (docstring.DocsTools method)</a>
</li>
      <li><a href="pyment_doc.html#docstring.GoogledocTools.get_param_list">get_param_list() (docstring.GoogledocTools method)</a>

      <ul>
        <li><a href="pyment_doc.html#docstring.NumpydocTools.get_param_list">(docstring.NumpydocTools method)</a>
</li>
      </ul></li>
      <li><a href="pyment_doc.html#docstring.DocsTools.get_param_type_indexes">get_param_type_indexes() (docstring.DocsTools method)</a>
</li>
      <li><a href="pyment_doc.html#docstring.DocsTools.get_raise_description_indexes">get_raise_description_indexes() (docstring.DocsTools method)</a>
</li>
      <li><a href="pyment_doc.html#docstring.DocsTools.get_raise_indexes">get_raise_indexes() (docstring.DocsTools method)</a>
</li>
      <li><a href="pyment_doc.html#docstring.GoogledocTools.get_raise_list">get_raise_list() (docstring.GoogledocTools method)</a>

      <ul>
        <li><a href="pyment_doc.html#docstring.NumpydocTools.get_raise_list">(docstring.NumpydocTools method)</a>
</li>
      </ul></li>
      <li><a href="pyment_doc.html#docstring.DocString.get_raw_docs">get_raw_docs() (docstring.DocString method)</a>
</li>
      <li><a href="pyment_doc.html#docstring.NumpydocTools.get_raw_not_managed">get_raw_not_managed() (docstring.NumpydocTools method)</a>
</li>
      <li><a href="pyment_doc.html#docstring.DocsTools.get_return_description_indexes">get_return_description_indexes() (docstring.DocsTools method)</a>
</li>
      <li><a href="pyment_doc.html#docstring.GoogledocTools.get_return_list">get_return_list() (docstring.GoogledocTools method)</a>

      <ul>
        <li><a href="pyment_doc.html#docstring.NumpydocTools.get_return_list">(docstring.NumpydocTools method)</a>
</li>
      </ul></li>
      <li><a href="pyment_doc.html#docstring.DocsTools.get_return_type_indexes">get_return_type_indexes() (docstring.DocsTools method)</a>
</li>
      <li><a href="pyment_doc.html#docstring.GoogledocTools.get_section_key_line">get_section_key_line() (docstring.GoogledocTools method)</a>

      <ul>
        <li><a href="pyment_doc.html#docstring.NumpydocTools.get_section_key_line">(docstring.NumpydocTools method)</a>
</li>
      </ul></li>
      <li><a href="pyment_doc.html#docstring.DocsTools.get_sep">get_sep() (docstring.DocsTools method)</a>
</li>
      <li><a href="pyment_doc.html#docstring.DocString.get_spaces">get_spaces() (docstring.DocString method)</a>
</li>
      <li><a href="pyment_doc.html#docstring.GoogledocTools">GoogledocTools (class in docstring)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="N">N</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="pyment_doc.html#docstring.NumpydocTools">NumpydocTools (class in docstring)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="P">P</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="pyment_doc.html#docstring.DocString.parse_docs">parse_docs() (docstring.DocString method)</a>
</li>
      <li><a href="pyment_doc.html#docstring.DocString.parse_element">parse_element() (docstring.DocString method)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="pyment_doc.html#pyment.PyComment.proceed">proceed() (pyment.PyComment method)</a>
</li>
      <li><a href="pyment_doc.html#pyment.PyComment">PyComment (class in pyment)</a>
</li>
      <li><a href="pyment_doc.html#module-pyment">pyment (module)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="S">S</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="pyment_doc.html#docstring.DocsTools.set_input_style">set_input_style() (docstring.DocsTools method)</a>

      <ul>
        <li><a href="pyment_doc.html#docstring.DocString.set_input_style">(docstring.DocString method)</a>
</li>
      </ul></li>
      <li><a href="pyment_doc.html#docstring.DocsTools.set_known_parameters">set_known_parameters() (docstring.DocsTools method)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="pyment_doc.html#docstring.DocsTools.set_output_style">set_output_style() (docstring.DocsTools method)</a>

      <ul>
        <li><a href="pyment_doc.html#docstring.DocString.set_output_style">(docstring.DocString method)</a>
</li>
      </ul></li>
      <li><a href="pyment_doc.html#docstring.DocString.set_spaces">set_spaces() (docstring.DocString method)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="W">W</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="pyment_doc.html#pyment.PyComment.write_to_file">write_to_file() (pyment.PyComment method)</a>
</li>
  </ul></td>
</tr></table>



          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">

   

<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <div><input type="text" name="q" /></div>
      <div><input type="submit" value="Go" /></div>
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="#" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">Pyment 0.3.2 documentation</a> &#187;</li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2017, Daouzli Adel.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.4.
    </div>
  </body>
</html>